Skip to content

doc: clarify verbose option help text#908

Merged
tobiasraabe merged 1 commit into
pytask-dev:mainfrom
cpz-research:verbose
Jun 7, 2026
Merged

doc: clarify verbose option help text#908
tobiasraabe merged 1 commit into
pytask-dev:mainfrom
cpz-research:verbose

Conversation

@cpz-research
Copy link
Copy Markdown
Contributor

Closes #907

Copilot AI review requested due to automatic review settings June 7, 2026 18:25
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Updates user-facing descriptions of the --verbose/-v option to clearly document the supported verbosity levels (0–2) and their meanings.

Changes:

  • Revised Click option help text for --verbose to explicitly describe levels 0/1/2.
  • Updated the build() docstring to match the new verbosity description.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
src/_pytask/parameters.py Clarifies CLI help text for the verbosity option by enumerating supported levels.
src/_pytask/build.py Aligns build() parameter documentation with the updated verbosity semantics.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 7, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.14%. Comparing base (ad3680e) to head (9a71421).
⚠️ Report is 309 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #908      +/-   ##
==========================================
- Coverage   97.80%   95.14%   -2.67%     
==========================================
  Files         106      125      +19     
  Lines        8710    11694    +2984     
==========================================
+ Hits         8519    11126    +2607     
- Misses        191      568     +377     
Flag Coverage Δ
end_to_end ?
integration ?
unit ?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@tobiasraabe tobiasraabe changed the title clarify verbose option help text doc: clarify verbose option help text Jun 7, 2026
@tobiasraabe tobiasraabe added this pull request to the merge queue Jun 7, 2026
Merged via the queue into pytask-dev:main with commit 7793c0d Jun 7, 2026
23 of 24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DOC: help text for pytask build --verbose is a bit confusing

3 participants